## API Report File for "@backstage/plugin-adr-backend"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts
/// <reference types="node" />

import { AdrDocument } from '@backstage/plugin-adr-common';
import { AdrFilePathFilterFn } from '@backstage/plugin-adr-common';
import { BackendFeature } from '@backstage/backend-plugin-api';
import { CacheClient } from '@backstage/backend-common';
import { CatalogApi } from '@backstage/catalog-client';
import { Config } from '@backstage/config';
import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
import { Entity } from '@backstage/catalog-model';
import express from 'express';
import { Logger } from 'winston';
import { PluginCacheManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { Readable } from 'stream';
import { TokenManager } from '@backstage/backend-common';
import { UrlReader } from '@backstage/backend-common';

// @public
export type AdrCollatorFactoryOptions = {
  adrFilePathFilterFn?: AdrFilePathFilterFn;
  cache: PluginCacheManager;
  config: Config;
  catalogClient?: CatalogApi;
  discovery: PluginEndpointDiscovery;
  logger: Logger;
  parser?: AdrParser;
  reader: UrlReader;
  tokenManager: TokenManager;
};

// @public
export type AdrParser = (ctx: AdrParserContext) => Promise<AdrDocument>;

// @public
export type AdrParserContext = {
  entity: Entity;
  content: string;
  path: string;
};

// @public
const adrPlugin: () => BackendFeature;
export default adrPlugin;

// @public (undocumented)
export type AdrRouterOptions = {
  reader: UrlReader;
  cacheClient: CacheClient;
  logger: Logger;
};

// @public
export const createMadrParser: (options?: MadrParserOptions) => AdrParser;

// @public (undocumented)
export function createRouter(
  options: AdrRouterOptions,
): Promise<express.Router>;

// @public
export class DefaultAdrCollatorFactory implements DocumentCollatorFactory {
  // (undocumented)
  execute(): AsyncGenerator<AdrDocument>;
  // (undocumented)
  static fromConfig(
    options: AdrCollatorFactoryOptions,
  ): DefaultAdrCollatorFactory;
  // (undocumented)
  getCollator(): Promise<Readable>;
  // (undocumented)
  readonly type: string;
}

// @public
export type MadrParserOptions = {
  locationTemplate?: string;
  dateFormat?: string;
};
```
